-
Notifications
You must be signed in to change notification settings - Fork 25
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update testing-guide.md #34
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for adding this. A few suggestions to try to keep the tone consistent throughout the guide.
docs/testing-guide.md
Outdated
@@ -110,6 +110,20 @@ Unlike the installer ISO, there isn't anything specific that needs to be done wh | |||
a raw image. EIB can be used to overwrite the raw image attached to a VM and, when the VM is booted, it will use | |||
the newly built image. | |||
|
|||
## Testing using virt-install (CLI) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we move this section up under the "Testing Self-installing ISOs" section and increase the indentation to ###
? This is only referring to the self-install ISO and would fit better there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Most are suggestions, but this is the only one I'd consider blocking the PR from landing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done!
docs/testing-guide.md
Outdated
@@ -110,6 +110,20 @@ Unlike the installer ISO, there isn't anything specific that needs to be done wh | |||
a raw image. EIB can be used to overwrite the raw image attached to a VM and, when the VM is booted, it will use | |||
the newly built image. | |||
|
|||
## Testing using virt-install (CLI) | |||
|
|||
If you want to use a command line example to deploy the VM and test it with your EIB image generated, you could use the following commands: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor nits:
"If you want to use the command line to deploy the VM and test it with your EIB generated image, you could use the following process:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks!
docs/testing-guide.md
Outdated
|
||
If you want to use a command line example to deploy the VM and test it with your EIB image generated, you could use the following commands: | ||
|
||
- First, we need to create a disk empty to be used by the VM: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Personal preference: For consistency with the rest of the doc, can we rephrase this to be more declarative instead of talking in the sense of "we are doing ___". For example, something like "The first step is to create an empty disk for the VM:"
docs/testing-guide.md
Outdated
|
||
`qemu-img create -f qcow2 example.img 6G` | ||
|
||
- Then, we could use virt-install to create and define a VM using the EIB output image generated: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Following on the previous comment: "Next, use virt-install
to define and run a VM using the EIB generated image:"
docs/testing-guide.md
Outdated
|
||
`virt-install --name testVM --memory 4096 --vcpus 4 --disk ./example.img --install no_install=yes --cdrom ./eib-image-generated.iso --network default --osinfo detect=on,name=sle-unknown` | ||
|
||
After executing this command, the first time, you will need to install the OS following the instructions. After installing the OS a reboot will happen. The second time booting the system, you will need to choose the `Boot From Disk` option. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Still following the suggestions around the tone of the doc: "During the first boot, you'll need to install the OS following the instructions. After installation, a reboot will happen. Subsequent boots will use the "Boot From Disk" option to boot from the installed OS."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
changed
docs/testing-guide.md
Outdated
|
||
- Then, we could use virt-install to create and define a VM using the EIB output image generated: | ||
|
||
`virt-install --name testVM --memory 4096 --vcpus 4 --disk ./example.img --install no_install=yes --cdrom ./eib-image-generated.iso --network default --osinfo detect=on,name=sle-unknown` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you explicitly add line breaks to make this more consistently readable? I'm thinking of something like:
virt-install \
--name testVM \
--memory 4096 \
--vcpus 4 \
--disk ./example.img \
--install no_install=yes \
--cdrom ./eib-image-generated.iso \
--network default \
--osinfo detect=on,name=sle-unknown`
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you're right
Add description for command line using virt-install